<!-- HTML header for doxygen 1.8.18-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Cube for iOS: CModule.h 源文件</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Cube for iOS
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- 制作者 Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'搜索','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','搜索');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_c_module_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">CModule.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="_c_module_8h.html">浏览该文件的文档.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * This file is part of Cube.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * The MIT License (MIT)</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * Copyright (c) 2020-2022 Shixin Cube Team.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * of this software and associated documentation files (the &quot;Software&quot;), to deal</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * in the Software without restriction, including without limitation the rights</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * copies of the Software, and to permit persons to whom the Software is</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * furnished to do so, subject to the following conditions:</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> * The above copyright notice and this permission notice shall be included in all</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> * copies or substantial portions of the Software.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"> * SOFTWARE.</span></div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor">#ifndef CModule_h</span></div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor">#define CModule_h</span></div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160; </div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="preprocessor">#import &quot;<a class="code" href="_c_subject_8h.html">CSubject.h</a>&quot;</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="keyword">@class</span> <a class="code" href="interface_c_kernel.html">CKernel</a>;</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="keyword">@class</span> <a class="code" href="interface_c_pipeline.html">CPipeline</a>;</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="keyword">@class</span> <a class="code" href="interface_c_error.html">CError</a>;</div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="keyword">@class</span> <a class="code" href="interface_c_plugin_system.html">CPluginSystem</a>;</div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="_c_module_8h.html#ab864a2cdc5ff506f8ece3f158cea0f4b">   38</a></span>&#160;<span class="keyword">typedef</span> void (^<a class="code" href="_c_module_8h.html#ab864a2cdc5ff506f8ece3f158cea0f4b">CubeFailureBlock</a>)(<a class="code" href="interface_c_error.html">CError</a> * _Nonnull error);</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="interface_c_module.html">   43</a></span>&#160;<span class="keyword">@interface </span><a class="code" href="interface_c_module.html">CModule</a> : <a class="code" href="interface_c_subject.html">CSubject</a></div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160; </div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="interface_c_module.html#a1b8b93be9419f3ee79e449d60f9b77c2">   46</a></span>&#160;<span class="keyword">@property</span> (nonatomic, nonnull, strong) NSString * <a class="code" href="interface_c_module.html#a1b8b93be9419f3ee79e449d60f9b77c2">name</a>;</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160; </div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="interface_c_module.html#a00abb412b5ff41b42943714f58f5e757">   49</a></span>&#160;<span class="keyword">@property</span> (nonatomic, nullable, strong) <a class="code" href="interface_c_kernel.html">CKernel</a> * <a class="code" href="interface_c_module.html#a00abb412b5ff41b42943714f58f5e757">kernel</a>;</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="interface_c_module.html#a7344ea3306b194db08416214f94f7ad4">   52</a></span>&#160;<span class="keyword">@property</span> (nonatomic, nullable, strong) <a class="code" href="interface_c_pipeline.html">CPipeline</a> * <a class="code" href="interface_c_module.html#a7344ea3306b194db08416214f94f7ad4">pipeline</a>;</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160; </div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="interface_c_module.html#a10a5247388b573f5488e28c912a0c474">   55</a></span>&#160;<span class="keyword">@property</span> (nonatomic, nonnull, strong, readonly) <a class="code" href="interface_c_plugin_system.html">CPluginSystem</a> * <a class="code" href="interface_c_module.html#a7ad669d6fb45cfaa0a27b1ee52ef1426">pluginSystem</a>;</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160; </div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;- (instancetype _Nonnull)initWithName:(NSString * _Nonnull)name;</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160; </div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;- (BOOL)<a class="code" href="interface_c_module.html#a10a5247388b573f5488e28c912a0c474">hasStarted</a>;</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160; </div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;- (BOOL)<a class="code" href="interface_c_module.html#a2e9a7f740dd2a8984f642a4f9d0dad7f">start</a>;</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160; </div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;- (void)<a class="code" href="interface_c_module.html#ac23c831eec40d2ecc7a9ebb2306073bf">stop</a>;</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160; </div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;- (void)<a class="code" href="interface_c_module.html#a9d060627c5f1c17f5cd7d18aa0dce8c0">suspend</a>;</div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160; </div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;- (void)<a class="code" href="interface_c_module.html#ab9c36fdba0fbd7bd0fb204c65be99ceb">resume</a>;</div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160; </div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;- (BOOL)<a class="code" href="interface_c_module.html#af14f87ab9be85cf00581109c98158e83">isReady</a>;</div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160; </div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;<span class="keyword">@end</span></div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160; </div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* CModule_h */</span><span class="preprocessor"></span></div>
<div class="ttc" id="a_c_module_8h_html_ab864a2cdc5ff506f8ece3f158cea0f4b"><div class="ttname"><a href="_c_module_8h.html#ab864a2cdc5ff506f8ece3f158cea0f4b">CubeFailureBlock</a></div><div class="ttdeci">void(^ CubeFailureBlock)(CError *_Nonnull error)</div><div class="ttdef"><b>Definition:</b> CModule.h:38</div></div>
<div class="ttc" id="a_c_subject_8h_html"><div class="ttname"><a href="_c_subject_8h.html">CSubject.h</a></div></div>
<div class="ttc" id="ainterface_c_error_html"><div class="ttname"><a href="interface_c_error.html">CError</a></div><div class="ttdef"><b>Definition:</b> CError.h:33</div></div>
<div class="ttc" id="ainterface_c_kernel_html"><div class="ttname"><a href="interface_c_kernel.html">CKernel</a></div><div class="ttdoc">内核。内核管理所有的模块和通信管道。</div><div class="ttdef"><b>Definition:</b> CKernel.h:109</div></div>
<div class="ttc" id="ainterface_c_module_html"><div class="ttname"><a href="interface_c_module.html">CModule</a></div><div class="ttdoc">内核模块。</div><div class="ttdef"><b>Definition:</b> CModule.h:44</div></div>
<div class="ttc" id="ainterface_c_module_html_a00abb412b5ff41b42943714f58f5e757"><div class="ttname"><a href="interface_c_module.html#a00abb412b5ff41b42943714f58f5e757">CModule::kernel</a></div><div class="ttdeci">CKernel * kernel</div><div class="ttdoc">内核。</div><div class="ttdef"><b>Definition:</b> CModule.h:49</div></div>
<div class="ttc" id="ainterface_c_module_html_a10a5247388b573f5488e28c912a0c474"><div class="ttname"><a href="interface_c_module.html#a10a5247388b573f5488e28c912a0c474">-[CModule hasStarted]</a></div><div class="ttdeci">BOOL hasStarted()</div><div class="ttdoc">是否已启动过该模块。</div></div>
<div class="ttc" id="ainterface_c_module_html_a1b8b93be9419f3ee79e449d60f9b77c2"><div class="ttname"><a href="interface_c_module.html#a1b8b93be9419f3ee79e449d60f9b77c2">CModule::name</a></div><div class="ttdeci">NSString * name</div><div class="ttdoc">模块名。</div><div class="ttdef"><b>Definition:</b> CModule.h:46</div></div>
<div class="ttc" id="ainterface_c_module_html_a2e9a7f740dd2a8984f642a4f9d0dad7f"><div class="ttname"><a href="interface_c_module.html#a2e9a7f740dd2a8984f642a4f9d0dad7f">-[CModule start]</a></div><div class="ttdeci">BOOL start()</div><div class="ttdoc">启动模块。</div></div>
<div class="ttc" id="ainterface_c_module_html_a7344ea3306b194db08416214f94f7ad4"><div class="ttname"><a href="interface_c_module.html#a7344ea3306b194db08416214f94f7ad4">CModule::pipeline</a></div><div class="ttdeci">CPipeline * pipeline</div><div class="ttdoc">模块使用的默认数据管道。</div><div class="ttdef"><b>Definition:</b> CModule.h:52</div></div>
<div class="ttc" id="ainterface_c_module_html_a7ad669d6fb45cfaa0a27b1ee52ef1426"><div class="ttname"><a href="interface_c_module.html#a7ad669d6fb45cfaa0a27b1ee52ef1426">CModule::pluginSystem</a></div><div class="ttdeci">CPluginSystem * pluginSystem</div><div class="ttdoc">插件系统。</div><div class="ttdef"><b>Definition:</b> CModule.h:55</div></div>
<div class="ttc" id="ainterface_c_module_html_a9d060627c5f1c17f5cd7d18aa0dce8c0"><div class="ttname"><a href="interface_c_module.html#a9d060627c5f1c17f5cd7d18aa0dce8c0">-[CModule suspend]</a></div><div class="ttdeci">void suspend()</div><div class="ttdoc">挂起模块。</div></div>
<div class="ttc" id="ainterface_c_module_html_ab9c36fdba0fbd7bd0fb204c65be99ceb"><div class="ttname"><a href="interface_c_module.html#ab9c36fdba0fbd7bd0fb204c65be99ceb">-[CModule resume]</a></div><div class="ttdeci">void resume()</div><div class="ttdoc">恢复模块。</div></div>
<div class="ttc" id="ainterface_c_module_html_ac23c831eec40d2ecc7a9ebb2306073bf"><div class="ttname"><a href="interface_c_module.html#ac23c831eec40d2ecc7a9ebb2306073bf">-[CModule stop]</a></div><div class="ttdeci">void stop()</div><div class="ttdoc">停止模块。</div></div>
<div class="ttc" id="ainterface_c_module_html_af14f87ab9be85cf00581109c98158e83"><div class="ttname"><a href="interface_c_module.html#af14f87ab9be85cf00581109c98158e83">-[CModule isReady]</a></div><div class="ttdeci">BOOL isReady()</div><div class="ttdoc">模块是否就绪。</div></div>
<div class="ttc" id="ainterface_c_pipeline_html"><div class="ttname"><a href="interface_c_pipeline.html">CPipeline</a></div><div class="ttdoc">数据通道服务接口。</div><div class="ttdef"><b>Definition:</b> CPipeline.h:60</div></div>
<div class="ttc" id="ainterface_c_plugin_system_html"><div class="ttname"><a href="interface_c_plugin_system.html">CPluginSystem</a></div><div class="ttdoc">插件系统。</div><div class="ttdef"><b>Definition:</b> CPluginSystem.h:37</div></div>
<div class="ttc" id="ainterface_c_subject_html"><div class="ttname"><a href="interface_c_subject.html">CSubject</a></div><div class="ttdef"><b>Definition:</b> CSubject.h:36</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.18-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_452bf2a1f165afdc57f378d186bca8c8.html">cube</a></li><li class="navelem"><a class="el" href="dir_170416ba8e842f45e64f4e38289ca8a1.html">Cube</a></li><li class="navelem"><a class="el" href="dir_87178645a19c09c8bd0356089af4ddcb.html">Core</a></li><li class="navelem"><a class="el" href="_c_module_8h.html">CModule.h</a></li>
    <li class="footer">制作者
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.9.1 </li>
  </ul>
</div>
</body>
</html>
